home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / id10.arc / ID.DOC < prev    next >
Text File  |  1992-01-08  |  12KB  |  254 lines
  1.  
  2.                      + -- -- -- -- -- -- -- -- -- -- -- -- +
  3.                      |                "ID"                 |
  4.                      |           v1.0 01/08/92             |
  5.                      |   Copyright (c) 1992 Ron Brandt     |
  6.                      |        All Rights Reserved          |
  7.                      |                                     |
  8.                      |  Satalink Information Systems BBS   |
  9.                      |         Sysop: Ron Brandt           |
  10.                      |        Post Office Box 449          |
  11.                      |  Huntingdon Valley, PA 19006-0449   |
  12.                      |        Phone (215) 364-8963         |
  13.                      |         BBS (215) 364-3324          |
  14.                      |                                     |
  15.                      + -- -- -- -- -- -- -- -- -- -- -- -- +
  16.  
  17. 1.0 Program Description:
  18. ------------------------
  19.  
  20. A utility for program authors to create and maintain FILE_ID.DIZ
  21. and DESC.SDI files for their original works. FILE_ID.DIZ and DESC.SDI
  22. are special file formats that can be edited and inserted into ZIP files
  23. by ID. With one of these files (or both) included with your programs
  24. your original description can be used by BBS's to post your exact de-
  25. scription (rather then them trying to guess or not accurately describing
  26. your programs) on their systems. As the file gets downloaded from there
  27. on out in the distribution chain it will maintain your original file
  28. descriptions. DESC.SDI or FILE_ID.DIZ are the only two file formats
  29. supported by ID. ID also only supports ZIP files for auto-updating or
  30. for inserting new descriptions. Also included in ID are suggested file
  31. formats that appear along side of the editor, using the suggested format
  32. will guarantee you an excellent description.
  33.  
  34. 2.0 Prohibited uses of ID:
  35. --------------------------
  36.  
  37. DO NOT use this program to create BBS Advertising as such use is in
  38. violation of the copyright associated with ID. DO NOT use this pro-
  39. gram to create ANY description file that will be inserted into a
  40. PKWARE -AV (PKZIP) archive that is not the creation of the original
  41. author. (NO BBS -AV Advertisement Archives). This is a violation of
  42. the -AV signature licensed by PKWARE INC.
  43.  
  44. 3.0 System Requirements:
  45. ------------------------
  46.  
  47. You must have a copy of PKZIP.EXE and PKUNZIP.EXE in your path to use
  48. ID. Both of these files are included in the file PKZ110.EXE available
  49. on just about every BBS worldwide and is made by PKWARE, INC. For
  50. information on obtaining PKWARE products contact PKWARE, INC. at:
  51. (404) 354-8699.
  52.  
  53.  
  54. 4.0 Why ID?:
  55. ------------
  56.  
  57. ID was created to make a simple chore even simpler! After seeing the
  58. number of files around that contain DESC.SDI and FILE_ID.DIZ files I
  59. asked several authors what they thought about the idea. The responses
  60. I got were shocking - seems that the majority of the authors that use
  61. DESC.SDI and FILE_ID.DIZ were by those that had some connection with
  62. a bulletin board. For the rest of the modemless world these file formats
  63. read like greek. I got responses like: "But I don't know what the format
  64. is.." or "Isn't there more than one file format?" and "But there is no
  65. easy way for me to do this"  Thus the birth of "ID".
  66.  
  67. 5.0 How to use ID:
  68. ------------------
  69.  
  70. ID.EXE will accept a command line parameter when you start it up:
  71.  
  72.                       ID x
  73.  
  74. Where X is the Drive;Path;Filename.ZIP of the ZIP file containing
  75. either a FILE_ID.DIZ or DESC.SDI file to be modified.
  76.  
  77.         Example:  ID C:\RELEASE\MYFILE.ZIP
  78.  
  79.  
  80. You can also run ID by itself by just typing "ID" once inside of
  81. ID you will be in the text editor.  You can use your cursor keys
  82. to move around the box and even enter in high ascii characters
  83. by using the ALT-NUMKEY method for making those nifty outlined
  84. boxes. Notice that the last two lines are off by themselves: You
  85. can continue typing your description on those lines or,  follow
  86. the suggested format I included and put your keywords on line 9
  87. and the author information on line 10. Note that there is no
  88. WORD WRAP - you can play with your wording so it makes use of
  89. every single character in the box.
  90.  
  91. After completing your description hit ESCAPE to exit the editor
  92. and bring up the command menu. Your options will be as follows:
  93.  
  94. 'Save as [F]ile_id.diz, [D]esc.sdi, [B]oth, [R]e-edit or [Q]uit'
  95.  
  96.  
  97. [F]ILE_ID.DIZ - save the file in FILE_ID.DIZ format only.
  98. [D]SEC.SDI - save the file in DESC.SDI format only.
  99. [B]oth - save the file in both FILE_ID.DIZ and DESC.SDI formats.
  100. [R]e-edit - This will take you back into the ID editor.
  101. [Q]uit - exit the program aborting your entry. (Save nothing).
  102.  
  103.  
  104. The next menu presented will give you these options:
  105.  
  106. '[S]ave as ASCII File, [A]dd ID to ZIP File, [R]e-edit or [Q]uit'
  107.  
  108. [A]dd to a ZIP file -  If you select this option ID will prompt you
  109.                        for the Drive;path;filename.zip of the ZIP
  110.                        file you want your description(s) inserted
  111.                        into. This will overwrite any DESC.SDI or
  112.                        FILE_ID.DIZ that may exist in the ZIP you
  113.                        you specify here.
  114.  
  115. [S]ave as ASCII file - This option will save your finished file(s)
  116.                        in the current directory as regular ascii
  117.                        files. You will need to manually add them
  118.                        to your archive if you use this method.
  119.  
  120. [Q]uit - Exit the program aborting your entry. (save nothing).
  121. [R]e-edit - this will take you back into the editor.
  122.  
  123.  
  124. 6.0 Suggested description Formats:
  125. ----------------------------------
  126.  
  127. As you will see on the right side of the box I have included some
  128. memory joggers - these are the items that make for a good descri-
  129. ption. Rather than list them here I put them inside of ID so you
  130. can read through them as you create your description and not forget
  131. any of the important details. I did not put the suggestions there
  132. to look good... I looked at thousands of file descriptions and
  133. picked out the best ones and noted the formats of them - the
  134. suggested format includes all of what I found. You can be an
  135. instant successful file description maker if you follow them or,
  136. you can always do it your way!
  137.  
  138. 7.0 Registration:
  139. -----------------
  140.  
  141.  * ID is shareware - if you like ID and would like to receive on disk
  142.    the registerd version please send $10 in US funds to the address
  143.    below. There is no difference in the registered version other than
  144.    it does not display the "Evaluation Copy" notice and by registering
  145.    you are showing your support for the shareware concept.  Mail Your
  146.    Check or money order made payable to 'RON BRANDT' for  $10.00 US
  147.    FUNDS ONLY to:
  148.  
  149.                         Satalink Information Systems BBS
  150.                               Post Office Box 449
  151.                         Huntingdon Valley, PA 19006-0449
  152.  
  153.         Be sure and specify your choice of media amd return address.
  154.  
  155.  * FREE OFFER TO PROGRAM AUTHORS:
  156.    If you write shareware programs you can obtain a FREE registered copy
  157.    of ID by mailing or uploading 3 of your original recently released
  158.    programs to me. I will in return mail to you free of charge a registered
  159.    copy of ID. You MUST include a FILE_ID.DIZ and DESC.SDI in your entry
  160.    and only files received in ZIP format will be accepted. All submissions
  161.    will be posted on my BBS for download as well as on an upcoming release
  162.    of a Shareware CD-ROM I publish. PLEASE NOTE: This offer is for NON-BBS
  163.    related Shareware. No Door's, BBS Utils etc will be accepted for credit.
  164.  
  165.    How to send your submissions:
  166.  
  167.   1) BBS NUMBER (215) 364-3324 Upload in Conference 10 - (Type "J;10" from
  168.      the main menu -All files uploaded in Conference 10 are held for review
  169.      by the SysOp and then posted) also leave E-Mail in conference 10 stating
  170.      that you are an author and that you have uploaded three files along with
  171.      your name, address and prefered media type and I'll mail you a registered
  172.      copy of ID FREE OF CHARGE.
  173.  
  174.   2) USPS ADDRESS: Satalink Info Systems BBS, PO Box 449 Huntingdon Valley
  175.      PA 19006-0449. Include three programs ZIPPED on 5 1/4" 360K or 1.2 Meg
  176.      floppies along with your name, address and prefered media size and I'll
  177.      mail you a registered copy of ID FREE OF CHARGE.
  178.  
  179. 8.0 Why Use FILE_ID.DIZ or DESC.SDI anyway?
  180. -------------------------------------------
  181.  
  182. Easy.. Just think of it this way: If you have taken the time to create a
  183. piece of software that you want distributed via the many BBS's in the world
  184. do you want some 9 year old sysop telling the world in his words what your
  185. program does once he downloads it from another BBS and decides to post it
  186. on his BBS? Example:
  187.  
  188. ID10.ZIP - Dudes! This is the most awesome file thingy around.
  189.  
  190. Now, your intended description read something like this:
  191.  
  192. ID10.ZIP - ID v1.0; Create, edit and modify FILE_ID.DIZ and DESC.SDI files.
  193.            ID is a menu driven dedicated text editor that will create either
  194.            FILE_ID.DIZ or DESC.SDI or BOTH file formats and place them in
  195.            ZIP files for you. ID takes all the guess work out of using these
  196.            file description schemes and simplifies the authors work.
  197.            12/15/91; Ron Brandt; Satalink Info Systems BBS (215) 364-3324
  198.  
  199. B I G difference! By creating a FILE_ID.DIZ and DESC.SDI description file
  200. and including it in your finished archives you are taking the needed steps
  201. to help insure that your hard work will be properly described down the road.
  202. One of the big advantages to using these file formats is that on some BBS's
  203. when a file uploaded contains a FILE_ID.DIZ or DESC.SDI the uploaders descr-
  204. iption is abandon and your description is used instead. This also makes for
  205. easier uploads - if a BBS is known to use a interface to read these special
  206. files you can save yourself allot of time typing descriptions - When asked
  207. for a description just type a few words and then upload it - the BBS will
  208. do all the work for you.
  209.  
  210. And.....The word wrap waste: Most BBS software will auto word wrap while
  211. you are typing in a description. This is wasting valuable description space
  212. that can only be taken advantage of by either planning exactly what you are
  213. going to type (assuming you knew how long a space you had) or... by using ID
  214. you could pre-type your description and utilize EVERY character of available.
  215. space.
  216.  
  217.  
  218. 9.0 Thanks to:
  219. --------------
  220.  
  221.     Bob Browne - As far as I can tell he was the originator of the
  222.     the idea by creating the file format DESC.SDI and a program to
  223.     look in ZIP files that were posted on RelayNet (RIME) (tm) so
  224.     that the national Hub and associated nodes would not end up
  225.     with description-less files.
  226.  
  227.     Clark Development Company - The creators of PCBoard and the
  228.     FILE_ID.DIZ file format and for writing the PCBoard utility
  229.     `PCB-DESCRIBE' that checks uploads for the FILE_ID.DIZ and
  230.     DESC.SDI and automatically uses it instead of the user supplied
  231.     description.
  232.  
  233.     Charlie Brandt - Master "C" Programmer for making ID possible.
  234.  
  235. 10.0 Warranty and legal Notices:
  236. --------------------------------
  237.  
  238. ID.EXE is provided AS IS without any warranty, expressed or implied.
  239. This includes without limitation the fitfulness to a particular purpose
  240. or application and any warranties of merchantability of any kind. I shall
  241. not be liable for any damages, whether direct, indirect, special, or con-
  242. sequential arising from a failure of ID.EXE to operate in a manner desired
  243. by the user.  I shall  not be  liable for  any damage to data or property
  244. which may by caused directly or indirectly by use or misuse of ID.EXE.
  245.  
  246. In no event will I be liable to you for any damages, including any lost
  247. profits, lost savings or other incidental or consequential damages arising
  248. out of your use or inability to use the program, or for any claim by any
  249. other party.
  250.  
  251.  
  252. PCBOARD is a registered trademark of Clark Development Company, inc.
  253. PKZIP is a registered trademark of PKWARE, Inc.
  254.